<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>キャッシュ可能なプラグインの出力の制御</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<link rel="home" href="index.html" title="Smarty マニュアル">
<link rel="up" href="caching.html" title="Chapter 14. キャッシュ">
<link rel="prev" href="caching.groups.html" title="キャッシュのグループ">
<link rel="next" href="advanced.features.html" title="Chapter 15. 拡張機能">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr><th colspan="3" align="center">キャッシュ可能なプラグインの出力の制御</th></tr>
<tr>
<td width="20%" align="left">
<a accesskey="p" href="caching.groups.html">Prev</a> </td>
<th width="60%" align="center">Chapter 14. キャッシュ</th>
<td width="20%" align="right"> <a accesskey="n" href="advanced.features.html">Next</a>
</td>
</tr>
</table>
<hr>
</div>
<div class="sect1" title="キャッシュ可能なプラグインの出力の制御">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="caching.cacheable"></a>キャッシュ可能なプラグインの出力の制御</h2></div></div></div>
<p>
   Smarty 2.6.0 から、プラグインを登録する際にキャッシュ可能なプラグインを宣言する事が出来ます。 
   <a class="link" href="api.register.block.html" title="register_block()"><code class="varname">register_block()</code></a>、
   <a class="link" href="api.register.compiler.function.html" title="register_compiler_function()">
   <code class="varname">register_compiler_function()</code></a> および
   <a class="link" href="api.register.function.html" title="register_function()"><code class="varname">register_function()</code></a>
   の第３パラメータは <em class="parameter"><code>$cacheable</code></em> と呼ばれ、デフォルトは
   <code class="constant">TRUE</code> です。この時、Smarty 2.6.0 以前のプラグインの振る舞いになります。
  </p>
<p>
   <code class="literal">$cacheable=false</code> であるプラグインが登録された時、
   プラグインはページがキャッシュから読まれる場合でもページを表示する度に呼ばれます。
   プラグイン関数は
   <a class="link" href="plugins.inserts.html" title="インサートプラグイン"><code class="varname">{insert}</code></a>
   関数に少し似た振る舞いをします。
  </p>
<p>
   <a class="link" href="plugins.inserts.html" title="インサートプラグイン"><code class="varname">{insert}</code></a>
   とは対照的に、プラグインの属性はデフォルトではキャッシュされません。
   キャッシュするためには第４パラメータ <em class="parameter"><code>$cache_attrs</code></em>
   によって宣言します。<em class="parameter"><code>$cache_attrs</code></em>
   はキャッシュされるべき属性の名前を格納した配列であり、
   プラグイン関数はページがキャッシュから取り出される度に
   属性はキャッシュに記述されていたものとして値を取得します。
  </p>
<div class="example">
<a name="id2853100"></a><p class="title"><b>Example 14.10. プラグインの出力がキャッシュされるのを防ぐ</b></p>
<div class="example-contents">
<pre class="programlisting">

&lt;?php
$smarty-&gt;caching = true;

function remaining_seconds($params, &amp;$smarty) {
    $remain = $params['endtime'] - time();
    if($remain &gt;= 0){
        return $remain . ' second(s)';
    }else{
        return 'done';
    }
}

$smarty-&gt;register_function('remaining', 'remaining_seconds', false, array('endtime'));

if (!$smarty-&gt;is_cached('index.tpl')) {
    // データベースから $obj を取り出して割り当てる
    $smarty-&gt;assign_by_ref('obj', $obj);
}

$smarty-&gt;display('index.tpl');
?&gt;

   </pre>
<p>
    <code class="filename">index.tpl</code> は次のようになります。
   </p>
<pre class="programlisting">

Time Remaining: {remaining endtime=$obj-&gt;endtime}

   </pre>
<p>
    たとえページがキャッシュされていても <code class="literal">$obj</code>
    の endtime の秒数までは各ページの表示は変更されていきます。
    その後のリクエストでページがキャッシュに書かれている時、
    endtime 属性がキャッシュされたのでオブジェクトをデータベースから取り出す必要があるだけです。
   </p>
</div>
</div>
<br class="example-break"><div class="example">
<a name="id2853171"></a><p class="title"><b>Example 14.11. テンプレートの一節がキャッシュされるのを防ぐ</b></p>
<div class="example-contents">
<pre class="programlisting">

index.php:

&lt;?php
$smarty-&gt;caching = 1;

function smarty_block_dynamic($param, $content, &amp;$smarty) {
    return $content;
}
$smarty-&gt;register_block('dynamic', 'smarty_block_dynamic', false);

$smarty-&gt;display('index.tpl');
?&gt;

   </pre>
<p>
    <code class="filename">index.tpl</code> は次のようになります。
   </p>
<pre class="programlisting">

Page created: {'0'|date_format:'%D %H:%M:%S'}

{dynamic}

Now is: {'0'|date_format:'%D %H:%M:%S'}

... 他にも何か ...

{/dynamic}

   </pre>
</div>
</div>
<br class="example-break"><p>
   ページをリロードした時に、両方の日付が異なる点に注意して下さい。
   一つは <span class="quote">“<span class="quote">dynamic</span>”</span> であり、もう一つは <span class="quote">“<span class="quote">static</span>”</span> です。
   <code class="literal">{dynamic}...{/dynamic}</code> 間に含まれるコンテンツ全てを動的に生成する事ができ、
   残るコンテンツはキャッシュされない事を確認して下さい。
  </p>
</div>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
<a accesskey="p" href="caching.groups.html">Prev</a> </td>
<td width="20%" align="center"><a accesskey="u" href="caching.html">Up</a></td>
<td width="40%" align="right"> <a accesskey="n" href="advanced.features.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">キャッシュのグループ </td>
<td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td>
<td width="40%" align="right" valign="top"> Chapter 15. 拡張機能</td>
</tr>
</table>
</div>
</body>
</html>
